<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: contrib/sIPOPT/src/SensUtils.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('SensUtils_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">SensUtils.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="IpUtils_8hpp_source.html">IpUtils.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="IpAlgTypes_8hpp_source.html">IpAlgTypes.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="IpReturnCodes_8hpp_source.html">IpReturnCodes.hpp</a>&quot;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="SensUtils_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceIpopt" id="r_namespaceIpopt"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html">Ipopt</a></td></tr>
<tr class="memdesc:namespaceIpopt"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file contains a base class for all exceptions and a set of macros to help with exceptions. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad63949cc73e4271b72a6d80e0625ff88" id="r_ad63949cc73e4271b72a6d80e0625ff88"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="SensUtils_8hpp.html#ad63949cc73e4271b72a6d80e0625ff88">DECLARE_STD_SIPOPT_EXCEPTION</a>(__except_type)</td></tr>
<tr class="separator:ad63949cc73e4271b72a6d80e0625ff88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:add98abac06d6862395ef27d827938126" id="r_add98abac06d6862395ef27d827938126"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126">Ipopt::SensAlgorithmExitStatus</a> { <a class="el" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126a293096ffc6a0550b6ab9f134ca79d013">Ipopt::SOLVE_SUCCESS</a>
, <a class="el" href="namespaceIpopt.html#add98abac06d6862395ef27d827938126aa9c8e97080fc5d2d8f01348bb5b3aa89">Ipopt::FATAL_ERROR</a>
 }</td></tr>
<tr class="separator:add98abac06d6862395ef27d827938126"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa39945f96a04d19ea6f24ffb67abe7e2" id="r_aa39945f96a04d19ea6f24ffb67abe7e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">SIPOPTLIB_EXPORT</a> <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html#aa39945f96a04d19ea6f24ffb67abe7e2">Ipopt::AsIndexMax</a> (<a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="el" href="classIpopt_1_1DependentResult.html">length</a>, <a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> *x, <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="el" href="classIpopt_1_1DependentResult.html">Incr</a>)</td></tr>
<tr class="separator:aa39945f96a04d19ea6f24ffb67abe7e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77ff4dbca9aa5d63b6ede7e77c56c16c" id="r_a77ff4dbca9aa5d63b6ede7e77c56c16c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">SIPOPTLIB_EXPORT</a> <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html#a77ff4dbca9aa5d63b6ede7e77c56c16c">Ipopt::AsIndexSum</a> (<a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="el" href="classIpopt_1_1DependentResult.html">length</a>, <a class="el" href="classIpopt_1_1DependentResult.html">const</a> <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> *x, <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="el" href="classIpopt_1_1DependentResult.html">Incr</a>)</td></tr>
<tr class="separator:a77ff4dbca9aa5d63b6ede7e77c56c16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a334ce463bb33929ee1ff24ce080241a8" id="r_a334ce463bb33929ee1ff24ce080241a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">SIPOPTLIB_EXPORT</a> <a class="el" href="classIpopt_1_1DependentResult.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html#a334ce463bb33929ee1ff24ce080241a8">Ipopt::append_Index</a> (std::string &amp;<a class="el" href="classIpopt_1_1DependentResult.html">str</a>, <a class="el" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Index</a> <a class="el" href="classIpopt_1_1DependentResult.html">idx</a>)</td></tr>
<tr class="separator:a334ce463bb33929ee1ff24ce080241a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92aaa8a8bbd6d35edb476bdb569b9d22" id="r_a92aaa8a8bbd6d35edb476bdb569b9d22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIpopt_1_1DependentResult.html">SIPOPTLIB_EXPORT</a> <a class="el" href="namespaceIpopt.html#a53a5dc5f64f568252ba7bb7385e7f834">SolverReturn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIpopt.html#a92aaa8a8bbd6d35edb476bdb569b9d22">Ipopt::AppReturn2SolverReturn</a> (<a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a> <a class="el" href="classIpopt_1_1DependentResult.html">ipopt_retval</a>)</td></tr>
<tr class="separator:a92aaa8a8bbd6d35edb476bdb569b9d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad63949cc73e4271b72a6d80e0625ff88" name="ad63949cc73e4271b72a6d80e0625ff88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad63949cc73e4271b72a6d80e0625ff88">&#9670;&#160;</a></span>DECLARE_STD_SIPOPT_EXCEPTION</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DECLARE_STD_SIPOPT_EXCEPTION</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">__except_type</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">    <span class="keyword">class </span>SIPOPTLIB_EXPORT  __except_type : <span class="keyword">public</span> <a class="code hl_class" href="classIpopt_1_1IpoptException.html">Ipopt::IpoptException</a> \</div>
<div class="line">    { \</div>
<div class="line">    <span class="keyword">public</span>: \</div>
<div class="line">      __except_type(<span class="keyword">const</span> std::string&amp; msg, <span class="keyword">const</span> std::string&amp; fname, <a class="code hl_typedef" href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Ipopt::Index</a> line) \</div>
<div class="line">      : <a class="code hl_class" href="classIpopt_1_1IpoptException.html">Ipopt::IpoptException</a>(msg,fname,line, #__except_type) {} \</div>
<div class="line">      __except_type(<span class="keyword">const</span> __except_type&amp; copy) \</div>
<div class="line">      : <a class="code hl_class" href="classIpopt_1_1IpoptException.html">Ipopt::IpoptException</a>(copy) {} \</div>
<div class="line">    <span class="keyword">private</span>: \</div>
<div class="line">       __except_type(); \</div>
<div class="line">       <span class="keywordtype">void</span> <a class="code hl_function" href="classIpopt_1_1IpoptException.html#aaef01182e1a6236110613dbf85b9bf33">operator=</a>(<span class="keyword">const</span> __except_type&amp;); \</div>
<div class="line">    }</div>
<div class="ttc" id="aclassIpopt_1_1IpoptException_html"><div class="ttname"><a href="classIpopt_1_1IpoptException.html">Ipopt::IpoptException</a></div><div class="ttdoc">This is the base class for all exceptions.</div><div class="ttdef"><b>Definition</b> <a href="IpException_8hpp_source.html#l00057">IpException.hpp:58</a></div></div>
<div class="ttc" id="aclassIpopt_1_1IpoptException_html_aaef01182e1a6236110613dbf85b9bf33"><div class="ttname"><a href="classIpopt_1_1IpoptException.html#aaef01182e1a6236110613dbf85b9bf33">Ipopt::IpoptException::operator=</a></div><div class="ttdeci">void operator=(const IpoptException &amp;)</div><div class="ttdoc">Default Assignment Operator.</div></div>
<div class="ttc" id="anamespaceIpopt_html_a5a4a27f325033a0e5d85a4ebc4038b57"><div class="ttname"><a href="namespaceIpopt.html#a5a4a27f325033a0e5d85a4ebc4038b57">Ipopt::Index</a></div><div class="ttdeci">ipindex Index</div><div class="ttdoc">Type of all indices of vectors, matrices etc.</div><div class="ttdef"><b>Definition</b> <a href="IpTypes_8hpp_source.html#l00020">IpTypes.hpp:20</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="SensUtils_8hpp_source.html#l00050">50</a> of file <a class="el" href="SensUtils_8hpp_source.html">SensUtils.hpp</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
